Skip to content

feat: API specs update for version latest#80

Merged
ChiragAgg5k merged 2 commits into
mainfrom
feat-latest-specs
Jun 11, 2026
Merged

feat: API specs update for version latest#80
ChiragAgg5k merged 2 commits into
mainfrom
feat-latest-specs

Conversation

@appwrite-specs

@appwrite-specs appwrite-specs Bot commented Jun 11, 2026

Copy link
Copy Markdown
Contributor

This PR contains API specification updates for version latest, regenerated through the OpenAPI 3 only pipeline (appwrite/sdk-generator 2.0.0 + appwrite/appwrite#12565).

It also removes the swagger2-latest-* spec files: specs are generated and consumed as OpenAPI 3 only now. Swagger 2 files for older versions (1.8.x and below) are kept as historical artifacts.

@greptile-apps

greptile-apps Bot commented Jun 11, 2026

Copy link
Copy Markdown

Greptile Summary

This PR extends the OAuth2 application consent model across all three OpenAPI 3 spec variants (client, console, server) with five new fields — tagline, tags, images, supportUrl, and dataDeletionUrl — and removes the legacy Swagger 2 specification files as part of the team's deliberate migration to an OpenAPI 3–only pipeline.

  • OAuth2 consent metadata fields (tagline, tags, images, supportUrl, dataDeletionUrl) are added consistently to both the create/update request body schemas and the appwriteApplication response model, including the required array, across all three specs.
  • Database model changes (console spec only): the type field is removed from the database create-request schema and the appwriteDatabase response model; default resource allocation is reduced (s-1vcpu-1gb, 1000 mCPU, 1024 MB, 10 GB storage); terminology is updated to replace "shared database" with "shared-pool database" and "type" with "node pool".
  • Swagger 2 specs deleted: all three swagger2-latest-*.json files are intentionally removed, confirmed by the commit message "remove swagger 2 specs for latest".

Confidence Score: 5/5

Safe to merge — all changes are consistent across spec variants and the swagger2 removal is intentional per the commit message.

The OAuth2 metadata fields are applied uniformly across client, console, and server specs in both request schemas and the response model. The database model updates in the console spec (type removal, reduced defaults, updated descriptions) align with the terminology shift reflected in the status and specification description changes. The swagger2 file deletions are explicitly described in the commit message as intentional cleanup.

No files require special attention beyond what was already discussed in previous review threads.

Important Files Changed

Filename Overview
specs/latest/open-api3-latest-client.json Adds five OAuth2 consent metadata fields (tagline, tags, images, supportUrl, dataDeletionUrl) to the application create and update request schemas and the appwriteApplication response model, including required array
specs/latest/open-api3-latest-console.json Same OAuth2 field additions as client; also removes the database type field from both the create-request schema and appwriteDatabase response model, reduces default specification/CPU/memory/storage values, updates status description and price example
specs/latest/open-api3-latest-server.json Same OAuth2 consent metadata field additions as the client spec; no database-model changes
specs/latest/swagger2-latest-client.json Intentionally deleted as part of the team's migration to an OpenAPI 3-only pipeline (commit message: "remove swagger 2 specs for latest")
specs/latest/swagger2-latest-console.json Intentionally deleted as part of the team's migration to an OpenAPI 3-only pipeline
specs/latest/swagger2-latest-server.json Intentionally deleted as part of the team's migration to an OpenAPI 3-only pipeline

Reviews (2): Last reviewed commit: "(chore): remove swagger 2 specs for late..." | Re-trigger Greptile

@@ -105895,7 +105960,6 @@
"$updatedAt",

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Removal of type from appwriteDatabase response model

The type field ("Database type: shared (serverless) or dedicated (always-on).") is removed from both the database-create request schema and the appwriteDatabase response model. Any existing console client that reads database.type to branch logic between shared and dedicated databases will silently receive undefined. The migration endpoint description still references "shared and dedicated types", so consumers navigating that flow may rely on this field. Worth confirming there is a migration guide or a deprecation notice for callers before this spec ships.

Comment on lines +4357 to +4365
"images": {
"type": "array",
"description": "Application image URLs shown to users during OAuth2 consent. Maximum of 100 images are allowed.",
"default": [],
"x-example": null,
"items": {
"type": "string"
}
},

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 images items missing format: "url" annotation

The images array items are typed as plain "type": "string" without a "format": "url" annotation, while the two sibling scalar URL fields supportUrl and dataDeletionUrl in the same request schema both carry "format": "url". SDK generators and validators that respect the format keyword will enforce URL format for those scalars but not for individual image entries. The same inconsistency appears in the update-operation block (~line 4615), and is repeated in the equivalent positions in open-api3-latest-console.json and open-api3-latest-server.json.

Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!

Specs are generated and consumed as OpenAPI 3 only since
appwrite/sdk-generator 2.0.0 and appwrite/appwrite#12565.
@ChiragAgg5k ChiragAgg5k merged commit db99261 into main Jun 11, 2026
2 checks passed
@ChiragAgg5k ChiragAgg5k deleted the feat-latest-specs branch June 11, 2026 08:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant